VimIMContext

Vim emulation.

The GtkSourceVimIMContext is a [class@Gtk.IMContext] implementation that can be used to provide Vim-like editing controls within a [class@View].

The GtkSourceViMIMContext will process incoming [class@Gdk.KeyEvent] as the user types. It should be used in conjunction with a [class@Gtk.EventControllerKey].

Various features supported by GtkSourceVimIMContext include:

- Normal, Insert, Replace, Visual, and Visual Line modes - Support for an integrated command bar and current command preview - Search and replace - Motions and Text Objects - History replay - Jumplists within the current file - Registers including the system and primary clipboards - Creation and motion to marks - Some commonly used Vim commands

It is recommended that applications display the contents of [property@VimIMContext:command-bar-text] and [property@VimIMContext:command-text] to the user as they represent the command-bar and current command preview found in Vim.

GtkSourceVimIMContext attempts to work with additional [class@Gtk.IMContext] implementations such as IBus by querying the [class@Gtk.TextView] before processing the command in states which support it (notably Insert and Replace modes).

GtkEventController *key;
GtkSourceView *view;
GtkIMContext *im_context;

view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();

gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (GTK_WIDGET (view), key);

g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);

class VimIMContext : IMContext {

protected

GtkSourceVimIMContext* gtkSourceVimIMContext;

GtkSourceVimIMContext* getVimIMContextStruct(bool transferOwnership);

void* getStruct();

this(GtkSourceVimIMContext* gtkSourceVimIMContext, bool ownedRef);

static GType getType();

this();

void executeCommand(string command);

string getCommandBarText();

string getCommandText();

gulong addOnEdit(void delegate(View, string, VimIMContext) dlg, ConnectFlags connectFlags);

gulong addOnExecuteCommand(bool delegate(string, VimIMContext) dlg, ConnectFlags connectFlags);

gulong addOnFormatText(void delegate(TextIter, TextIter, VimIMContext) dlg, ConnectFlags connectFlags);

gulong addOnWrite(void delegate(View, string, VimIMContext) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkSourceVimIMContext* gtkSourceVimIMContext, bool ownedRef): Sets our main struct and passes it to the parent class.
this this()

Members

Functions

addOnEdit gulong addOnEdit(void delegate(View, string, VimIMContext) dlg, ConnectFlags connectFlags): Requests the application open the file found at @path.
addOnExecuteCommand gulong addOnExecuteCommand(bool delegate(string, VimIMContext) dlg, ConnectFlags connectFlags): The signal is emitted when a command should be executed. This might be something like :wq or :e <path>.
addOnFormatText gulong addOnFormatText(void delegate(TextIter, TextIter, VimIMContext) dlg, ConnectFlags connectFlags): Requests that the application format the text between @begin and @end.
addOnWrite gulong addOnWrite(void delegate(View, string, VimIMContext) dlg, ConnectFlags connectFlags): Requests the application save the file.
executeCommand void executeCommand(string command): Executes @command as if it was typed into the command bar by the user except that this does not emit the [signal@VimIMContext::execute-command] signal.
getCommandBarText string getCommandBarText(): Gets the current command-bar text as it is entered by the user.
getCommandText string getCommandText(): Gets the current command text as it is entered by the user.
getStruct void* getStruct(): the main Gtk struct as a void*
getVimIMContextStruct GtkSourceVimIMContext* getVimIMContextStruct(bool transferOwnership): Get the main Gtk struct

Static functions

getType GType getType()

Variables

gtkSourceVimIMContext GtkSourceVimIMContext* gtkSourceVimIMContext;: the main Gtk struct

Inherited Members

From IMContext

gtkIMContext GtkIMContext* gtkIMContext;: the main Gtk struct
getIMContextStruct GtkIMContext* getIMContextStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
deleteSurrounding bool deleteSurrounding(int offset, int nChars): Asks the widget that the input context is attached to delete characters around the cursor position by emitting the ::delete_surrounding signal.
filterKey bool filterKey(bool press, Surface surface, Device device, uint time, uint keycode, GdkModifierType state, int group): Allow an input method to forward key press and release events to another input method without necessarily having a GdkEvent available.
filterKeypress bool filterKeypress(Event event): Allow an input method to internally handle key press and release events.
focusIn void focusIn(): Notify the input method that the widget to which this input context corresponds has gained focus.
focusOut void focusOut(): Notify the input method that the widget to which this input context corresponds has lost focus.
getPreeditString void getPreeditString(string str, PgAttributeList attrs, int cursorPos): Retrieve the current preedit string for the input context, and a list of attributes to apply to the string.
getSurrounding bool getSurrounding(string text, int cursorIndex): Retrieves context around the insertion point.
getSurroundingWithSelection bool getSurroundingWithSelection(string text, int cursorIndex, int anchorIndex): Retrieves context around the insertion point.
reset void reset(): Notify the input method that a change such as a change in cursor position has been made.
setClientWidget void setClientWidget(Widget widget): Set the client widget for the input context.
setCursorLocation void setCursorLocation(GdkRectangle* area): Notify the input method that a change in cursor position has been made.
setSurrounding void setSurrounding(string text, int len, int cursorIndex): Sets surrounding context around the insertion point and preedit string.
setSurroundingWithSelection void setSurroundingWithSelection(string text, int len, int cursorIndex, int anchorIndex): Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve_surrounding] signal, and will likely have no effect if called at other times.
setUsePreedit void setUsePreedit(bool usePreedit): Sets whether the IM context should use the preedit string to display feedback.
addOnCommit gulong addOnCommit(void delegate(string, IMContext) dlg, ConnectFlags connectFlags): The ::commit signal is emitted when a complete input sequence has been entered by the user.
addOnDeleteSurrounding gulong addOnDeleteSurrounding(bool delegate(int, int, IMContext) dlg, ConnectFlags connectFlags): The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.
addOnPreeditChanged gulong addOnPreeditChanged(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.
addOnPreeditEnd gulong addOnPreeditEnd(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.
addOnPreeditStart gulong addOnPreeditStart(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-start signal is emitted when a new preediting sequence starts.
addOnRetrieveSurrounding gulong addOnRetrieveSurrounding(bool delegate(IMContext) dlg, ConnectFlags connectFlags): The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.